@react-md/theme
Advanced tools
The base package for including a theme for react-md. This is required by most other packages.
This package is used for creating a color theme within react-md. It also exposes some utility Components and mixins for updating the theme at runtime through CSS Variables.
This package can be installed through npm if you want access to all the SCSS
variables, functions, and mixins or by using the pre-compiled bundles hosted on
https://unpkg.com.
npm install --save @react-md/theme
Full usage and documentation can be found on the main documentation site at the theme page, but there will be a few examples in this README.
Starting with v2.0.0, react-md will use both SCSS and css variables to define themes. This allows you to use the nice dynamic themes with css variables in evergreen browsers but also support the older ones if needed.
The default theme is:
$rmd-theme-primary: $rmd-purple-500 !default;
$rmd-theme-secondary: $rmd-pink-a-400 !default;
// the background color for your app. Normally applied to the base <html> tag
$rmd-theme-background: #fafafa !default;
// the background color for "surfaces" (things like dialogs, menus, cards, etc)
$rmd-theme-surface: #fff !default;
This can be overridden by setting these variables to new colors that are
included in react-md, or a custom color by re-defining these values before
importing the main theme file.
If you override the $rmd-theme-light variable to be false, the default theme
will be:
$rmd-theme-primary: $rmd-purple-500 !default;
$rmd-theme-secondary: $rmd-pink-a-400 !default;
// the background color for your app. Normally applied to the base <html> tag
$rmd-theme-background: #303030 !default;
// the background color for "surfaces" (things like dialogs, menus, cards, etc)
$rmd-theme-surface: $md-grey-800 !default;
If the theme colors are one of the material design colors, you can use some of the existing SCSS variables to update your theme.
Example:
@import "~@react-md/theme/dist/color-palette";
$rmd-theme-primary: $rmd-blue-500;
$rmd-theme-secondary: $rmd-orange-a-400;
@import "~@react-md/theme/dist/mixins";
@include react-md-theme;
Note that the theme variables were overridden before importing the main
theme file. You might have problems overriding the theme if you define them
after.
Since your company might have specific branding colors, it is also possible to define a theme that does not have material design colors at all.
$my-awesome-company-purple: #9b59b6;
$my-awesome-company-orange: #e67e22;
$rmd-theme-primary: $my-awesome-company-purple;
$rmd-theme-secondary: $my-awesome-company-orange;
@import "~@react-md/theme/dist/mixins";
@include react-md-theme;
To make including custom styles easy, it might be helpful to create the following files in your project:
src/_branding.scss - A file that contains the color variables for your
company's brandingsrc/_react-md-overrides.scss - A file that contains the react-md variable
overrides with new valuessrc/_all.scss - A file that is used as a quick import to include all
available variables, mixins, and functions within any file in your app for
conveniencesrc/index.scss - A file that is used to generate your base stylesExample:
// in src/_branding.scss
$my-awesome-company-purple: #9b59b6;
$my-awesome-company-orange: #e67e22;
// in src/_react-md-overrides.scss
@import "branding";
$rmd-theme-primary: $my-awesome-company-purple;
$rmd-theme-secondary: $my-awesome-company-orange;
// in src/_all.scss
@import "my-awesome-company-branding";
@import "my-awesome-company-react-md-overrides";
@import "~@react-md/theme/dist/mixins";
// in src/index.scss
@import "all";
@include react-md-theme;
FAQs
The base package for including a theme for react-md. This is required by most other packages.
The npm package @react-md/theme receives a total of 2,152 weekly downloads. As such, @react-md/theme popularity was classified as popular.
We found that @react-md/theme demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.